/*
 * Copyright (C) 2007-2012 by XDEV Software, All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 3.0 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
package xdev.ui;


import javax.swing.text.JTextComponent;


/**
 * Settings enumeration for the behavior of a text component after it gained the
 * focus.
 * 
 * @author XDEV Software
 * @since 3.1
 */
public enum FocusGainedBehavior
{
	/**
	 * Lets the system handle the behavior.
	 * <p>
	 * This is the default behavior.
	 */
	SYSTEM_DEFAULT,

	/**
	 * The cursor is placed at the begin of the text comopnent.
	 */
	CURSOR_TO_BEGIN
	{
		@Override
		public void focusGained(JTextComponent txt)
		{
			txt.setCaretPosition(0);
		}
	},
	
	/**
	 * The cursor is placed at the end of the text comopnent.
	 */
	CURSOR_TO_END
	{
		@Override
		public void focusGained(JTextComponent txt)
		{
			txt.setCaretPosition(txt.getDocument().getLength());
		}
	},
	
	/**
	 * Selects all the text in the text component.
	 */
	SELECT_ALL
	{
		@Override
		public void focusGained(JTextComponent txt)
		{
			txt.selectAll();
		}
	};
	
	final static String	PROPERTY_NAME	= "focusGainedBehavior";
	

	/**
	 * Performs the appropriate action.
	 * 
	 * @param txt
	 *            the text component
	 */
	public void focusGained(JTextComponent txt)
	{
	}
}
